API Docs for: 1.0.1
Show:

Store (Client) Class

Defined in: src/client/store.js:1
Module: Client

A lightweight datastore wrapper

Methods

Options

() private

Options (Configuration)

Options.constructor

() private

Options.constructor

process

(
  • action
  • options
  • item
  • callback
  • each
)
Boolean

Asynchronous remote action processing

Parameters:

  • action String

    [list, get, update, remove]

  • options Object

    configuration

  • item Object

    arbitrary object *

  • callback Function

    handle

  • each Boolean

    apply callback fnc for each object? (default: false)

Returns:

Boolean:

Returns true on success

processSync

(
  • action
  • options
  • item
  • callback
  • each
)
Boolean

Synchronous remote action processing

Parameters:

  • action String

    [list, get, update, remove]

  • options Object

    configuration

  • item Object

    arbitrary object *

  • callback Function

    handle

  • each Boolean

    apply callback fnc for each object? (default: false)

Returns:

Boolean:

Returns true on success

Remote

() private

Repository.Remote

Remote.constructor

() private

Repository.Remote.constructor

Repository

() private

Repository

Repository.constructor

() private

Repository constructor

Properties

options.cache

Boolean

Cache enabled

Default: true

options.jsonp

String

JSONP callback fnc name

Default: "callback"

options.namespace

String

Storage namespace

Default: "default"

options.ttl

Number

Cache Lifetime

Default: 3600

options.url

String

Remote storage location

Default: "//localhost/store/examples/server.php"